Feat(logger): log event functionality #1004

saragerion · 2022-06-22T22:53:27Z

Description of your changes

This PR introduces a new functionality: logging Lambda events. Developers can opt in for this behaviour by one of the following methods:

passing the parameter logEvent set to true to the injectLambdaContext middleware
passing the parameter logEvent set to true to the injectLambdaContext decorator
setting the env var POWERTOOLS_LOGGER_LOG_EVENT to through while using the injectLambdaContext middleware/decorator

Note that this functionality is only available when using a middleware or decorator.

The Lambda invocation will then print one log item with the following key-value pairs:

logLevel INFO
message key with value Lambda invocation event
event key with the current Lambda invocation event as value

Logging a Lambda event is very typical use of a logger in AWS Lambda. This logic aims to simplify and reduce the code that developers need to maintain.

How to verify this change

See E2E tests results.

To see the docs:

npm run docs-website-build-run

Related issues, RFCs

#482

PR status

Is this ready for review?: YES
Is it a breaking change?: NO

Checklist

Breaking change checklist

I have documented the migration process
I have added, implemented necessary warnings (if it can live side by side)

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

github-actions · 2022-06-22T23:02:29Z

📊 Package size report `1%↑`

File	Before	After
`aws-lambda-powertools-logger-0.10.0.tgz`	`22.9 kB`	^4%↑`23.7 kB`
`logger-bundle.zip`	`23.4 kB`	^3%↑`24.2 kB`
Total _{(Includes all files)}	`138.6 kB`	^1%↑`140.2 kB`
Tarball size	`137.4 kB`	^1%↑`139.0 kB`

Unchanged files

File	Size
`aws-lambda-powertools-commons-0.10.0.tgz`	`6.5 kB`
`aws-lambda-powertools-metrics-0.10.0.tgz`	`17.5 kB`
`aws-lambda-powertools-tracer-0.10.0.tgz`	`21.4 kB`
`commons-bundle.zip`	`7.0 kB`
`metrics-bundle.zip`	`18.0 kB`
`tracer-bundle.zip`	`21.9 kB`

_{🤖 This report was automatically generated by pkg-size-action}
(options hash: e084ed7e8abaceaf318cc37424bd7f7a)

packages/logger/tests/e2e/basicFeatures.middy.test.FunctionCode.ts

github-actions · 2022-06-23T10:51:52Z

📊 Package size report `1%↑`

File	Before	After
`aws-lambda-powertools-logger-0.10.0.tgz`	`22.9 kB`	^4%↑`23.7 kB`
`logger-bundle.zip`	`23.4 kB`	^3%↑`24.2 kB`
Total _{(Includes all files)}	`138.6 kB`	^1%↑`140.2 kB`
Tarball size	`137.4 kB`	^1%↑`139.0 kB`

Unchanged files

File	Size
`aws-lambda-powertools-commons-0.10.0.tgz`	`6.5 kB`
`aws-lambda-powertools-metrics-0.10.0.tgz`	`17.5 kB`
`aws-lambda-powertools-tracer-0.10.0.tgz`	`21.4 kB`
`commons-bundle.zip`	`7.0 kB`
`metrics-bundle.zip`	`18.0 kB`
`tracer-bundle.zip`	`21.9 kB`

_{🤖 This report was automatically generated by pkg-size-action}
(options hash: 7baa0109941e106e7ebfcd7771808605)

docs/core/logger.md

package.json

github-actions · 2022-06-23T12:48:09Z

📊 Package size report `1%↑`

File	Before	After
`aws-lambda-powertools-logger-0.10.0.tgz`	`22.9 kB`	^4%↑`23.7 kB`
`logger-bundle.zip`	`23.4 kB`	^3%↑`24.2 kB`
Total _{(Includes all files)}	`138.6 kB`	^1%↑`140.2 kB`
Tarball size	`137.4 kB`	^1%↑`139.0 kB`

Unchanged files

File	Size
`aws-lambda-powertools-commons-0.10.0.tgz`	`6.5 kB`
`aws-lambda-powertools-metrics-0.10.0.tgz`	`17.5 kB`
`aws-lambda-powertools-tracer-0.10.0.tgz`	`21.4 kB`
`commons-bundle.zip`	`7.0 kB`
`metrics-bundle.zip`	`18.0 kB`
`tracer-bundle.zip`	`21.9 kB`

_{🤖 This report was automatically generated by pkg-size-action}
(options hash: 5c696c1703417abbb857a9081c753d78)

flochaz

LGTM

dreamorosi · 2022-06-23T13:26:42Z

CONTRIBUTING.md

-You can build and start a local docs website by running these two commands:
+You can build and start a local docs website by running:  
+
+`npm run docs-website-build-run`


would be cool in the future (not this PR) to have an additional combo command to run the docs & the API docs at the same time

It's done here! I did not document it yet, my bad
https://github.com/awslabs/aws-lambda-powertools-typescript/pull/1004/files#diff-7ae45ad102eab3b6d7e7896acd08c427a9b25b346470d7bc6507b6481575d519R35

Sorry, I meant something like (name is just an example):

"docs-run-docs-and-api": "npm run docs-runLocalDocker && npm run docs-api-build-run"

This command would allow you to run the documentation + the API docs so you can browse between both. Right now when editing locally, if you start from the docs and click on "API Docs" on the left navigation menu it gives you a 404 because there's nothing on the /api path.

But again, we can do it at some point in the future!

saragerion · 2022-06-23T13:54:40Z

E2E tests:
https://github.com/awslabs/aws-lambda-powertools-typescript/actions/runs/2549417761

dreamorosi

Thanks for this PR, looking forward to merge it!

A couple of minor notes, which I will capture in a separate issue for later:

I'd like to see a corresponding method for manual mode like logger.logEvent(event); - this is purely syntactic sugar as you can easily do logger.debug('event', { event }); but still.
Since in the docs we call out that this method is for debugging only, I'd expect the log level to be DEBUG instead of INFO.
In the packages/logger/src/middy.ts docstring of the injectLambdaContext middleware we should document the new flag/new behaviour so that it appears also in the API docs.
In the new sub-section of the docs where we show this method, it'd be nice to have a log excerpt. I was not sure which key the event would use in the JSON log (event duh).

* feat(logger): log event, add business logic and unit tests * test(logger): add log event support * feat(logger): add env variable for log event * test(logger): middy * chore(logger): middy polish for log event * test(logger): fix log event unit tests * test(logger): unit + e2e tests for log event functionality * docs(logger): add log event * docs: add single line command for docs generation * docs: fix typo in env vars section

saragerion added 8 commits March 2, 2022 09:08

feat(logger): log event, add business logic and unit tests

bcfce3d

test(logger): add log event support

72a4466

feat(logger): add env variable for log event

4a6e541

test(logger): middy

1a35b8e

merge with main

28f0a07

chore(logger): middy polish for log event

a632918

test(logger): fix log event unit tests

46bade5

test(logger): unit + e2e tests for log event functionality

68ce025

saragerion commented Jun 23, 2022

View reviewed changes

packages/logger/tests/e2e/basicFeatures.middy.test.FunctionCode.ts Show resolved Hide resolved

saragerion added this to the production-ready-release milestone Jun 23, 2022

saragerion self-assigned this Jun 23, 2022

docs(logger): add log event

01ed9bd

dreamorosi reviewed Jun 23, 2022

View reviewed changes

docs/core/logger.md Show resolved Hide resolved

saragerion linked an issue Jun 23, 2022 that may be closed by this pull request

Feature request: feature parity with Python Powertools logger #482

Closed

8 tasks

saragerion added 2 commits June 23, 2022 14:27

docs: add single line command for docs generation

d887485

docs: fix typo in env vars section

8d50e5c

saragerion commented Jun 23, 2022

View reviewed changes

package.json Show resolved Hide resolved

saragerion marked this pull request as ready for review June 23, 2022 12:51

saragerion requested review from dreamorosi and flochaz June 23, 2022 12:53

flochaz approved these changes Jun 23, 2022

View reviewed changes

dreamorosi reviewed Jun 23, 2022

View reviewed changes

dreamorosi approved these changes Jun 23, 2022

View reviewed changes

saragerion merged commit 9a976ca into main Jun 23, 2022

saragerion deleted the feat/logger-log-event branch June 23, 2022 14:12

dreamorosi mentioned this pull request Jun 23, 2022

Feature request: logEvent method for manual usage #1006

Closed

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feat(logger): log event functionality #1004

Feat(logger): log event functionality #1004

saragerion commented Jun 22, 2022 •

edited

Loading

github-actions bot commented Jun 22, 2022 •

edited

Loading

github-actions bot commented Jun 23, 2022 •

edited

Loading

github-actions bot commented Jun 23, 2022 •

edited

Loading

flochaz left a comment

dreamorosi Jun 23, 2022

saragerion Jun 23, 2022

dreamorosi Jun 23, 2022

saragerion commented Jun 23, 2022

dreamorosi left a comment •

edited

Loading

Feat(logger): log event functionality #1004

Feat(logger): log event functionality #1004

Conversation

saragerion commented Jun 22, 2022 • edited Loading

Description of your changes

How to verify this change

Related issues, RFCs

PR status

Checklist

Breaking change checklist

github-actions bot commented Jun 22, 2022 • edited Loading

📊 Package size report 1%↑

github-actions bot commented Jun 23, 2022 • edited Loading

📊 Package size report 1%↑

github-actions bot commented Jun 23, 2022 • edited Loading

📊 Package size report 1%↑

flochaz left a comment

Choose a reason for hiding this comment

dreamorosi Jun 23, 2022

Choose a reason for hiding this comment

saragerion Jun 23, 2022

Choose a reason for hiding this comment

dreamorosi Jun 23, 2022

Choose a reason for hiding this comment

saragerion commented Jun 23, 2022

dreamorosi left a comment • edited Loading

Choose a reason for hiding this comment

saragerion commented Jun 22, 2022 •

edited

Loading

github-actions bot commented Jun 22, 2022 •

edited

Loading

📊 Package size report `1%↑`

github-actions bot commented Jun 23, 2022 •

edited

Loading

📊 Package size report `1%↑`

github-actions bot commented Jun 23, 2022 •

edited

Loading

📊 Package size report `1%↑`

dreamorosi left a comment •

edited

Loading